<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Wally The Sentry Bot: MegaMan/MegaMan.h File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Wally The Sentry Bot
   &#160;<span id="projectnumber">0.2</span>
   </div>
   <div id="projectbrief">A silly Arduino project to play with sensors, Xbees and a Peggy 2.0 pegboard</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('_mega_man_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">MegaMan/MegaMan.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_mega_man_8h__dep__incl.png" border="0" usemap="#_mega_man_2_mega_man_8hdep" alt=""/></div>
<map name="_mega_man_2_mega_man_8hdep" id="_mega_man_2_mega_man_8hdep">
<area shape="rect" id="node3" href="_mega_man_8ino.html" title="Control module for Peggy. Creates animations and graphics for Peggy as well as playing audio via MP3 ..." alt="" coords="5,160,165,189"/><area shape="rect" id="node5" href="p2anim_8h.html" title="MegaMan/p2anim.h" alt="" coords="115,83,251,112"/><area shape="rect" id="node8" href="p2anim_8cpp.html" title="MegaMan/p2anim.cpp" alt="" coords="205,160,355,189"/></map>
</div>
</div>
<p><a href="_mega_man_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga88866375a97efd9911514c81c87d5929"></a><!-- doxytag: member="MegaMan.h::getRightN" ref="ga88866375a97efd9911514c81c87d5929" args="(pixelByte)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga88866375a97efd9911514c81c87d5929">getRightN</a>(pixelByte)&#160;&#160;&#160;(pixelByte &amp; 0x0F)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the right 4bit nibble from pixelByte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9d44d6425f8227b6cbefb103eb8a3fa5"></a><!-- doxytag: member="MegaMan.h::getLeftN" ref="ga9d44d6425f8227b6cbefb103eb8a3fa5" args="(pixelByte)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga9d44d6425f8227b6cbefb103eb8a3fa5">getLeftN</a>(pixelByte)&#160;&#160;&#160;(pixelByte &gt;&gt; 4 &amp; 0x0F)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the left 4bit nibble from pixelByte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab304dddbd1678551085bc66d54776d90"></a><!-- doxytag: member="MegaMan.h::setRightN" ref="gab304dddbd1678551085bc66d54776d90" args="(buffer, pixelByte)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gab304dddbd1678551085bc66d54776d90">setRightN</a>(buffer, pixelByte)&#160;&#160;&#160;buffer = (buffer &amp; 0xF0 | (pixelByte &amp; 0x0F))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set right 4bit nibble of buffer with content of pixelByte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7417764fac912650a002010fbb4d02d7"></a><!-- doxytag: member="MegaMan.h::setLeftN" ref="ga7417764fac912650a002010fbb4d02d7" args="(buffer, pixelByte)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga7417764fac912650a002010fbb4d02d7">setLeftN</a>(buffer, pixelByte)&#160;&#160;&#160;buffer = (buffer &amp; 0x0F| (pixelByte &lt;&lt; 4 &amp; 0xF0))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set left 4bit nibble of buffer with content of pixelByte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga23569b6fb24ec4bd1583b2ee506df91b"></a><!-- doxytag: member="MegaMan.h::joinNibbles" ref="ga23569b6fb24ec4bd1583b2ee506df91b" args="(pixelByte, lsbPixel, msbPixel)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga23569b6fb24ec4bd1583b2ee506df91b">joinNibbles</a>(pixelByte, lsbPixel, msbPixel)&#160;&#160;&#160;pixelByte = (lsbPixel &amp; 0x0F| msbPixel &lt;&lt; 4 &amp; 0xF0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Join two 4bit nibbles (lsbPixel and msbPixel) into a single byte (pixelByte) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gade3c083fa7b1178fcca5671e1830f2f9"></a><!-- doxytag: member="MegaMan.h::BIT_SET" ref="gade3c083fa7b1178fcca5671e1830f2f9" args="(a, b)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gade3c083fa7b1178fcca5671e1830f2f9">BIT_SET</a>(a, b)&#160;&#160;&#160;((a) |= (1&lt;&lt;(b)))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bit number b of register/byte/variable a. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga77fc3a931d1ad5fa08201e5c544817a0"></a><!-- doxytag: member="MegaMan.h::BIT_CLEAR" ref="ga77fc3a931d1ad5fa08201e5c544817a0" args="(a, b)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga77fc3a931d1ad5fa08201e5c544817a0">BIT_CLEAR</a>(a, b)&#160;&#160;&#160;((a) &amp;= ~(1&lt;&lt;(b)))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bit number b of register/byte/variable a. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab6e0e32ff769c3cf2953456593e5663e"></a><!-- doxytag: member="MegaMan.h::BIT_FLIP" ref="gab6e0e32ff769c3cf2953456593e5663e" args="(a, b)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gab6e0e32ff769c3cf2953456593e5663e">BIT_FLIP</a>(a, b)&#160;&#160;&#160;((a) ^= (1&lt;&lt;(b)))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Flip bit number b of register/byte/variable a. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab53403b709717305a8d0a8e692a70de6"></a><!-- doxytag: member="MegaMan.h::BIT_CHECK" ref="gab53403b709717305a8d0a8e692a70de6" args="(a, b)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gab53403b709717305a8d0a8e692a70de6">BIT_CHECK</a>(a, b)&#160;&#160;&#160;((a) &amp; (1&lt;&lt;(b)))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if bit number b of register/byte/variable is set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b7116275ff2309adc0f8a5b5a249039"></a><!-- doxytag: member="MegaMan.h::BITMASK_SET" ref="ga2b7116275ff2309adc0f8a5b5a249039" args="(x, y)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga2b7116275ff2309adc0f8a5b5a249039">BITMASK_SET</a>(x, y)&#160;&#160;&#160;((x) |= (y))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set bitmask y on variable x. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1c1eeb80a540f03a0fdcd5a58bc40bf2"></a><!-- doxytag: member="MegaMan.h::BITMASK_CLEAR" ref="ga1c1eeb80a540f03a0fdcd5a58bc40bf2" args="(x, y)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga1c1eeb80a540f03a0fdcd5a58bc40bf2">BITMASK_CLEAR</a>(x, y)&#160;&#160;&#160;((x) &amp;= (~(y)))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear bitmask y on variable x. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf855e6d4c97dd8def12b1b736ad9c93f"></a><!-- doxytag: member="MegaMan.h::BITMASK_FLIP" ref="gaf855e6d4c97dd8def12b1b736ad9c93f" args="(x, y)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gaf855e6d4c97dd8def12b1b736ad9c93f">BITMASK_FLIP</a>(x, y)&#160;&#160;&#160;((x) ^= (y))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Flip bitmask y onto variable x. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1ce97811962c682fbb08a857efd22d67"></a><!-- doxytag: member="MegaMan.h::BITMASK_CHECK" ref="ga1ce97811962c682fbb08a857efd22d67" args="(x, y)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga1ce97811962c682fbb08a857efd22d67">BITMASK_CHECK</a>(x, y)&#160;&#160;&#160;((x) &amp; (y))</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for bitmask y on variable x. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad3481dd6138035714f76dc5e63d4f313"></a><!-- doxytag: member="MegaMan.h::imageFromFlash" ref="gad3481dd6138035714f76dc5e63d4f313" args="(unsigned char *)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gad3481dd6138035714f76dc5e63d4f313">imageFromFlash</a> (unsigned char *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies an image from flash to Peggy. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac6a31f9107dfe32d9d1683cf733864c4"></a><!-- doxytag: member="MegaMan.h::updatePeggyDisplay" ref="gac6a31f9107dfe32d9d1683cf733864c4" args="(char *)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#gac6a31f9107dfe32d9d1683cf733864c4">updatePeggyDisplay</a> (char *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates Peggy - by sending custom made headers. All processing takes place on Peggy. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga103f160680926ae94837d236f4f1ca8a"></a><!-- doxytag: member="MegaMan.h::alterBuffer" ref="ga103f160680926ae94837d236f4f1ca8a" args="(char *, unsigned char *)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga103f160680926ae94837d236f4f1ca8a">alterBuffer</a> (char *, unsigned char *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the frameBuffer - typically to create graphical effects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga64b15cf19ae6a81a307e4b9163b1f717"></a><!-- doxytag: member="MegaMan.h::sendBuffer" ref="ga64b15cf19ae6a81a307e4b9163b1f717" args="(uint8_t *)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga64b15cf19ae6a81a307e4b9163b1f717">sendBuffer</a> (uint8_t *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit the frameBuffer to Peggy. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2d106db4253178eb0b86bb1f83826fdc"></a><!-- doxytag: member="MegaMan.h::putPixel" ref="ga2d106db4253178eb0b86bb1f83826fdc" args="(uint8_t, uint8_t, uint8_t)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga2d106db4253178eb0b86bb1f83826fdc">putPixel</a> (uint8_t, uint8_t, uint8_t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Display single pixel on Peggy through slow method of transferring entire frameBuffer. <br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga044badc155ada65f4dbd410a3741f75e"></a><!-- doxytag: member="MegaMan.h::abortFlag" ref="ga044badc155ada65f4dbd410a3741f75e" args="" -->
boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___mega_man.html#ga044badc155ada65f4dbd410a3741f75e">abortFlag</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to abort execution if external event demands it. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"></div></div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="_mega_man_8h.html">MegaMan.h</a>      </li>

    <li class="footer">Generated on Thu May 24 2012 00:05:01 for Wally The Sentry Bot by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
